Creates a copy of an existing collection.

Collection CopyCollection (
    Collection srcCollection, 
    Collection dstCollection
);

srcCollection

A reference to the collection object you want to copy. The behavior of this function is undefined if you do not provide a reference to a valid collection object.

dstCollection

A reference to a collection object to contain the copied collection items. You may provide NULL for this parameter to request that the Collection Manager create a new collection object to hold the copied information.

function result

A reference to the collection object containing the copied information.

DISCUSSION

The CopyCollection function copies all of the information (except the owner count and exception procedure) from the collection object referenced by the srcCollection parameter into the collection object referenced by the dstCollection parameter.

If you specify NULL for the dstCollection parameter, this function creates a new collection object to copy the information into. (This function does not return an error code; it returns NULL if it cannot create a new collection object.)

To clone a collection object, use the DisposeCollection function.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.

© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)